﻿// --------------------------------------------------------------------------------------------------------------------
// <copyright file="UpdateFileHeaderStyle.cs" company="StyleCop for ReSharper Development Team">
//   Copyright (c) StyleCop for ReSharper Development Team. All rights reserved.
// </copyright>
// <summary>
//   Defines the UpdateFileHeaderStyle type.
// </summary>
// --------------------------------------------------------------------------------------------------------------------

namespace StyleCop.For.ReSharper.CodeCleanup.Styles
{
    #region Using Directives

    using System.ComponentModel;

    #endregion

    /// <summary>
    /// Enumeration to define the behaviour for updating the file header.
    /// </summary>
    public enum UpdateFileHeaderStyle
    {
        /// <summary>
        /// Do not change.
        /// </summary>
        [Description("Do not change")]
        Ignore,

        /// <summary>
        /// Only insert if missing.
        /// </summary>
        [Description("Insert header if it's missing")]
        InsertMissing,

        /// <summary>
        /// Replaces the copyright element completely.
        /// </summary>
        [Description("Replace copyright element completely")]
        ReplaceCopyrightElement,

        /// <summary>
        /// Replace all.
        /// </summary>
        [Description("Replace entire header")]
        ReplaceAll
    }
}